VIVE 3DSP Native C Library
ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
vive_3dsp_api
room.h
Go to the documentation of this file.
1
//========= Copyright 2016-2018, HTC Corporation. All rights reserved. ===========
2
#pragma once
3
#include "
audio_engine.h
"
4
5
#ifdef __cplusplus
6
extern
"C"
{
7
#endif
8
9
namespace
HTC_Vive3DSP_SDK
{
10
/*****************************************************************************************************************/
11
/* Room properties */
12
/*****************************************************************************************************************/
13
19
typedef
struct
vive_3dsp_internal_room_
vive_3dsp_room
;
20
24
enum
RoomBackgroundAudioType
25
{
26
BG_None
= 0,
27
BG_BigRoom
,
28
BG_SmallRoom
,
29
BG_AirConditioner
,
30
BG_Refrigerator
,
31
BG_PinkNoise
,
32
BG_BrownNoise
,
33
BG_WhiteNoise
,
34
BG_Preserved
,
36
BG_NUM
37
};
38
43
struct
VIVE_3DSP_ROOM_PROPERTY
{
44
VIVE_3DSP_Vector3
position
;
45
VIVE_3DSP_Quaternion
rotation
;
46
VIVE_3DSP_Vector3
size
;
47
VIVE_3DSP_ROOM_REVERB_PRESET
preset
;
48
VIVE_3DSP_REVERB_MATERIAL
material
[6];
49
float
reflection_rate
[6];
50
float
gain
;
51
float
dry_level
;
52
float
reflection_level
;
53
float
reverb_level
;
54
//VIVE_3DSP_REVERB_MODEL reverb_model; /**< The physical occlusion engine. Please refer to \c ::VIVE_3DSP_OCCLUSION_ENGINE. */
55
};
56
65
VIVE_3DSP_API_DLLEXPORT
vive_3dsp_room
*
66
vive_3dsp_room_create_object(
vive_3dsp_context
*api);
76
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
77
vive_3dsp_room_destroy_object(
vive_3dsp_context
*api,
vive_3dsp_room
*room);
88
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
89
vive_3dsp_room_set_size(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
VIVE_3DSP_Vector3
size);
100
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
101
vive_3dsp_room_set_position(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
VIVE_3DSP_Vector3
pos);
112
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
113
vive_3dsp_room_set_rotation(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
VIVE_3DSP_Quaternion
rot);
127
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
128
vive_3dsp_room_set_material(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
VIVE_3DSP_ROOM_PLANE
room_plane,
VIVE_3DSP_REVERB_MATERIAL
room_material);
140
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
141
vive_3dsp_room_set_reverb_preset(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
VIVE_3DSP_ROOM_REVERB_PRESET
room_reverb_preset);
155
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
156
vive_3dsp_room_set_reflection(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
VIVE_3DSP_ROOM_PLANE
room_plane,
float
rate);
167
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
168
vive_3dsp_room_set_gain(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
float
gain);
179
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
180
vive_3dsp_room_enable(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
bool
enable);
191
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
192
vive_3dsp_room_setDryLevel(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
float
level_dB);
203
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
204
vive_3dsp_room_setReflectionLevel(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
float
level_dB);
215
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
216
vive_3dsp_room_setReverbLevel(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
float
level_dB);
227
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
228
vive_3dsp_room_set_property(
vive_3dsp_context
*api,
vive_3dsp_room
*room,
VIVE_3DSP_ROOM_PROPERTY
prop);
238
VIVE_3DSP_API_DLLEXPORT
float
*
239
vive_3dsp_room_get_bgaudio(
vive_3dsp_context
*api,
int
id
);
249
VIVE_3DSP_API_DLLEXPORT
VIVE_3DSP_API_STATUS
250
vive_3dsp_room_free_bgaudio(
vive_3dsp_context
*api,
float
*pBgaudio);
251
}
252
#ifdef __cplusplus
253
}
254
#endif
HTC_Vive3DSP_SDK::VIVE_3DSP_Quaternion
Definition:
audio_engine.h:158
HTC_Vive3DSP_SDK::VIVE_3DSP_Vector3
Definition:
audio_engine.h:144
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::preset
VIVE_3DSP_ROOM_REVERB_PRESET preset
Definition:
room.h:47
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY
Definition:
room.h:43
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PLANE
VIVE_3DSP_ROOM_PLANE
Definition:
audio_engine.h:77
HTC_Vive3DSP_SDK::VIVE_3DSP_API_STATUS
VIVE_3DSP_API_STATUS
Definition:
audio_engine.h:25
VIVE_3DSP_API_DLLEXPORT
#define VIVE_3DSP_API_DLLEXPORT
Definition:
audio_engine.h:6
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::reflection_level
float reflection_level
Definition:
room.h:52
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::material
VIVE_3DSP_REVERB_MATERIAL material[6]
Definition:
room.h:48
audio_engine.h
HTC_Vive3DSP_SDK::BG_NUM
Definition:
room.h:36
HTC_Vive3DSP_SDK::BG_None
Definition:
room.h:26
HTC_Vive3DSP_SDK::BG_Refrigerator
Definition:
room.h:30
HTC_Vive3DSP_SDK::BG_BrownNoise
Definition:
room.h:32
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::gain
float gain
Definition:
room.h:50
HTC_Vive3DSP_SDK::BG_WhiteNoise
Definition:
room.h:33
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_REVERB_PRESET
VIVE_3DSP_ROOM_REVERB_PRESET
Definition:
audio_engine.h:68
HTC_Vive3DSP_SDK::BG_AirConditioner
Definition:
room.h:29
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::reverb_level
float reverb_level
Definition:
room.h:53
HTC_Vive3DSP_SDK::BG_Preserved
Definition:
room.h:34
HTC_Vive3DSP_SDK::BG_SmallRoom
Definition:
room.h:28
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::reflection_rate
float reflection_rate[6]
Definition:
room.h:49
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::position
VIVE_3DSP_Vector3 position
Definition:
room.h:44
vive_3dsp_context
The vive_3dsp_context structure represents the overall audio engine of 3D sound model.
HTC_Vive3DSP_SDK
Definition:
vive_3dsp_api.h:15
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::dry_level
float dry_level
Definition:
room.h:51
HTC_Vive3DSP_SDK::VIVE_3DSP_REVERB_MATERIAL
VIVE_3DSP_REVERB_MATERIAL
Definition:
audio_engine.h:51
vive_3dsp_room
The vive_3dsp_room structure represents the 3D room model, including the reflection and reverberation...
HTC_Vive3DSP_SDK::RoomBackgroundAudioType
RoomBackgroundAudioType
Definition:
room.h:24
HTC_Vive3DSP_SDK::BG_PinkNoise
Definition:
room.h:31
HTC_Vive3DSP_SDK::BG_BigRoom
Definition:
room.h:27
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::rotation
VIVE_3DSP_Quaternion rotation
Definition:
room.h:45
HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_PROPERTY::size
VIVE_3DSP_Vector3 size
Definition:
room.h:46
Generated by
1.8.14